home *** CD-ROM | disk | FTP | other *** search
/ BBS in a Box 22 / AMUG_22-1.ISO / Files / Internet / Web Things / Hyperize 1.1.sit / Hyperize Folder / About Hyperize next >
Encoding:
Text File  |  1995-12-17  |  6.4 KB  |  159 lines  |  [TEXT/ttxt]
  1. HYPERIZE v1.1
  2.  
  3. Freeware.
  4.  
  5. Hyperize is a simple utility to convert text files into acceptable HTML. It is
  6. very small, very fast, and operates with the minimum of fuss. There is no limit
  7. on the number or size of files which it can process.
  8.  
  9. WHAT IT DOES
  10.  
  11. For each input file, Hyperize creates an output file with the same name as the
  12. input file plus ".html". The input file itself is not changed. Files whose name
  13. already ends in ".html" are skipped.
  14.  
  15. Hyperize surrounds your text with opening and closing <HTML>, <HEAD> and <BODY>
  16. tags, and it uses the input file name to create a <TITLE>...</TITLE> tag. The rest 
  17. depends on what mode you select. Hyperize can convert text in three different modes:
  18. normal, preformatted, and wrap.
  19.  
  20. In all modes, Hyperize translates the special characters '<', '>' and '&' into
  21. their HTML escape codes, and additionally translates all characters >127 into
  22. appropriate escape codes or at least into something acceptable. For instance,
  23. accented characters like é become é and fancy quotes become the
  24. corresponding ordinary quotes. These translations are also made to the file
  25. name which is used as the title. (All the translations for characters >127 are 
  26. in resources, so you can change them in ResEdit. They are in STR# resource 129.
  27. Whatever you do, make sure there are still exactly 128 of them!)
  28.  
  29. In preformatted mode, this is all that Hyperize does apart from surrounding the
  30. body of the text with <PRE>...</PRE> tags. This is useful for program listings
  31. and various other purposes.
  32.  
  33. In normal mode, Hyperize also does the following:
  34.  
  35. - it translates single returns into <BR> and collapses multiple returns into <P>
  36. (it ignores intervening white space);
  37.  
  38. - where a return is followed by spaces or tabs and then text, it writes a <P> tag
  39. instead of <BR>. This is useful for translating text where paragraph beginnings
  40. are indented but not preceded by a blank line;
  41.  
  42. - wherever an output line gets longer than 72 characters, Hyperize replaces the
  43. next space or tab in the input with a return.
  44.  
  45. In wrap mode, Hyperize does the same processing as for normal mode, except that
  46. it changes single returns into either spaces or returns, depending on the length
  47. of the output line. However, if the next line begins with white space, Hyperize
  48. translates the return into <P>, just as in normal mode. Wrap mode is intended for
  49. use on files created with text editors that use returns to separate lines rather
  50. than paragraphs.
  51.  
  52.  
  53. HOW TO USE IT
  54.  
  55. You can use Hyperize either interactively or by dragging and dropping files onto
  56. it. When you drag and drop, Hyperize processes the files and then quits. You
  57. can drag and drop big clumps of files — Hyperize will skip those that are not
  58. text files or that end in ".html".
  59.  
  60. In interactive mode, Hyperize awaits your commands until you choose Quit from the
  61. File menu or press Command-Q. You can translate files in interactive mode, but
  62. you'd most likely use it to set preferences.
  63.  
  64. The preferences involve the choice of translation mode, the creator type of
  65. output files, and whether you want to be warned when a file name is too long.
  66. This can happen when Hyperize attempts to add ".html" to a file name that is
  67. already 26+ characters long. In this case, Hyperize repeatedly strips off the
  68. last character of the (original) file name until it finds a new unique name, and
  69. finally defaults to a base of the form "tempN" (where N is a digit string) if it
  70. stripped the name to nothing and still did not find a unique name. In either
  71. case, it adds ".html" to this base. If you've set warnings off, Hyperize proceeds
  72. to create and write a file of this name. If you've set warnings on, Hyperize
  73. offers a dialog which gives you the option to go with that name, choose a name
  74. yourself from the Standard File Dialog, skip the file, or cancel the whole
  75. operation. (I'm still not entirely happy with this interface -- it seems fussy.
  76. Future versions might handle it differently.)
  77.  
  78. Hyperize stores your preferences in its resource fork. Therefore you can't run
  79. Hyperize (or at least you can't change preferences) from a locked volume. The
  80. default settings are mode=normal, warnings=on, creator='ttxt'.
  81.  
  82. All literal strings, including those in warning and error messages, are stored in
  83. resources, so you can easily localize the application if you're prepared to do a
  84. bit of hacking in ResEdit. (They are in STR# resource 128.) The only exception is
  85. the contents of the About box. Please, if you do a localization, could you let
  86. me know so I can keep track of the various versions around.
  87.  
  88. WHAT IT COSTS
  89.  
  90. Nothing. Therefore I can't promise any support. But I do like e-mail, so you can
  91. send suggestions for improvement or even just paeans of praise.
  92.  
  93.  
  94. WHAT IT PROMISES
  95.  
  96. Nothing, beyond converting your text files into bare-bones acceptable HTML. You
  97. will almost certainly have to go into the file and tweak headings, tables, and
  98. other formatting. Hyperize does not presume to know what you want your document
  99. to look like. Nor do I, for that matter.
  100.  
  101.  
  102. WHAT IT REQUIRES
  103.  
  104. Hyperize requires System 7. Period. Oh, and a Macintosh.
  105.  
  106.  
  107. WHAT IT MIGHT GET EVENTUALLY
  108.  
  109. My wish list for Hyperize includes:
  110.  
  111. - recognize single lines not ending in punctuation and turn them into headings;
  112.  
  113. - process whole folders;
  114.  
  115. - add an option to turn tab-delimited data into HTML tables [hard];
  116.  
  117. - make the translations of 8-bit characters conform to ISO 8879-1986 -- not
  118.   till all browsers are conformant as well.
  119.  
  120. These things may or may not happen eventually. That partly depends on you :-)
  121.  
  122.  
  123. ALTERNATIVES
  124.  
  125. For a slightly different approach to the task, you might like to try Scott
  126. Kleper's HTML Markup. This is a more fully featured, memory-based text-to-HTML
  127. converter with many options. $15 shareware from:
  128.  
  129.     ftp://htc.rit.edu/pub/HTML-Markup-current.hqx
  130.  
  131. There are many utilities that produce HTML apart from these two, most of them
  132. specialized to a particular format such as RTF, PostScript, or Excel. A fairly
  133. complete list can be found at:
  134.  
  135.     http://www.w3.org/hypertext/WWW/Tools/Filters.html
  136.  
  137. VERSION HISTORY
  138.  
  139. v1.1 (December 1995)
  140.     - added translations for file name in title
  141.     - added STR resource for character 255
  142.     - fixed occurrences of '<' and '>' in >127 translations
  143.     - fixed incorrect œ for æ
  144.     - got rid of Œ and œ (not in HTML DTD)
  145.     - changed wrong version number in this file
  146.     
  147. v1.0 (November 1995)
  148.     - initial release
  149.     
  150. At any time, the current version is available at my web site:
  151.  
  152.     http://www.usyd.edu.au/~jcj/
  153.     
  154.  
  155. Jason Johnston 
  156. <jcj@extro.ucc.su.oz.au>
  157.  
  158. December 1995
  159.